IRIX Base Documentation 2001 May

home *** CD-ROM | disk | FTP | other *** search

/ IRIX Base Documentation 2001 May / SGI IRIX Base Documentation 2001 May.iso / usr / share / catman / u_man / cat1 / X11 / xman.z / xman

Wrap

Text File | 1998-10-30 | 28.3 KB | 595 lines

XXXXMMMMAAAANNNN((((1111)))) XXXX VVVVeeeerrrrssssiiiioooonnnn 11111111 ((((RRRReeeelllleeeeaaaasssseeee 5555)))) XXXXMMMMAAAANNNN((((1111)))) NNNNAAAAMMMMEEEE xman - Manual page display program for the X Window System SSSSYYYYNNNNOOOOPPPPSSSSIIIISSSS xxxxmmmmaaaannnn [ -_o_p_t_i_o_n_s ... ] DDDDEEEESSSSCCCCRRRRIIIIPPPPTTTTIIIIOOOONNNN _X_m_a_n is a manual page browser. This is international version to browse manual written in various languages. Although this manual is written in English, an user can change any English menu label below to that one written in other language. The default size of the initial _x_m_a_n window is small so that you can leave it running throughout your entire login session. In the initial window there are three options: _H_e_l_p will pop up a window with on-line help, _Q_u_i_t will exit, and _M_a_n_u_a_l _P_a_g_e will pop up a window with a manual page browser in it. Typing Control-S will pop up a window prompting for a specific manual page to display. You may display more than one manual page browser window at a time from a single execution of _x_m_a_n. For further information on using _x_m_a_n, please read the on- line help information. Most of this manual will discuss customization of _x_m_a_n. OOOOPPPPTTTTIIIIOOOONNNNSSSS Xman supports all standard Toolkit command line arguments (see _X(1)). The following additional arguments are supported. ----hhhheeeellllppppffffiiiilllleeee _f_i_l_e_n_a_m_e Specifies a helpfile to use other than the default. ----bbbbooootttthhhhsssshhhhoooowwwwnnnn Allows both the manual page and manual directory to be on the screen at the same time. ----nnnnoooottttooooppppbbbbooooxxxx Starts without the Top Menu with the three buttons in it. ----ggggeeeeoooommmmeeeettttrrrryyyy _W_x_H+_X+_Y Sets the size and location of the Top Menu with the three buttons in it. ----ppppaaaaggggeeeessssiiiizzzzeeee _W_x_H+_X+_Y Sets the size and location of all the Manual Pages. ----ttttbbbbllll _c_o_m_m_a_n_d_n_a_m_e Page 1 (printed 4/30/98) XXXXMMMMAAAANNNN((((1111)))) XXXX VVVVeeeerrrrssssiiiioooonnnn 11111111 ((((RRRReeeelllleeeeaaaasssseeee 5555)))) XXXXMMMMAAAANNNN((((1111)))) Sets the command of tbl function, default is tbl. ----eeeeqqqqnnnn _c_o_m_m_a_n_d_n_a_m_e Sets the command of eqn function, default is neqn. ----rrrrooooffffffff _c_o_m_m_a_n_d_n_a_m_e Sets the command of roff function, default is nroff. The roff commands(tbl,neqn and nroff) is used by xman to preprocess the manual page. If the default commands can not handle your local language, please find and choose others on your platform. One example is jnroff on LUNA workstation for manual in Japanese. CCCCUUUUSSSSTTTTOOOOMMMMIIIIZZZZIIIINNNNGGGG XXXXMMMMAAAANNNN _X_m_a_n allows customization of both the directories to be searched for manual pages, and the name that each directory will map to in the _S_e_c_t_i_o_n_s menu. Xman determines which directories it will search by reading the _M_A_N_P_A_T_H environment variable. If no _M_A_N_P_A_T_H is found then the directory is /usr/man is searched on POSIX systems. This environment is expected to be a colon-separated list of directories for xman to search. setenv MANPATH /mit/kit/man:/usr/man By default, _x_m_a_n will search each of the following directories (in each of the directories specified in the users MANPATH) for manual pages. If manual pages exist in that directory then they are added to list of manual pages for the corresponding menu item. A menu item is only displayed for those sections that actually contain manual pages. Directory Section Name --------- ------------ man1 (1) User Commands man2 (2) System Calls man3 (3) Subroutines man4 (4) Devices man5 (5) File Formats man6 (6) Games man7 (7) Miscellaneous man8 (8) Sys. Administration manl (l) Local mann (n) New mano (o) Old For instance, a user has three directories in her manual path and each contain a directory called _m_a_n_3. All these manual pages will appear alphabetically sorted when the user selects the menu item called (_3) _S_u_b_r_o_u_t_i_n_e_s. If there is Page 2 (printed 4/30/98) XXXXMMMMAAAANNNN((((1111)))) XXXX VVVVeeeerrrrssssiiiioooonnnn 11111111 ((((RRRReeeelllleeeeaaaasssseeee 5555)))) XXXXMMMMAAAANNNN((((1111)))) no directory called _m_a_n_o in any of the directories in her MANPATH, or there are no manual pages in any of the directories called _m_a_n_o then no menu item will be displayed for the section called (_o) _O_l_d. TTTTHHHHEEEE MMMMAAAANNNNDDDDEEEESSSSCCCC FFFFIIIILLLLEEEE By using the _m_a_n_d_e_s_c file a user or system manager is able to more closely control which manual pages will appear in each of the sections represented by menu items in the _S_e_c_t_i_o_n_s menu. This functionality is only available on a section by section basis, and individual manual pages may not be handled in this manner. (Although generous use of symbolic links - see _l_n(1) - will allow almost any configuration you can imagine.) The format of the mandesc file is a character followed by a label. The character determines which of the sections will be added under this label. For instance suppose that you would like to create an extra menu item that contains all programmer subroutines. This label should contain all manual pages in both sections two and three. The _m_a_n_d_e_s_c file would look like this: 2Programmer Subroutines 3Programmer Subroutines This will add a menu item to the _S_e_c_t_i_o_n_s menu that would bring up a listing of all manual pages in sections two and three of the Programmers Manual. Since the label names are _e_x_a_c_t_l_y the same they will be added to the same section. Note, however, that the original sections still exist. If you want to completely ignore the default sections in a manual directory then add the line: no default sections anywhere in your mandesc file. This keeps xman from searching the default manual sections _I_n _t_h_a_t _d_i_r_e_c_t_o_r_y _o_n_l_y. As an example, suppose you want to do the same thing as above, but you don't think that it is useful to have the _S_y_s_t_e_m _C_a_l_l_s or _S_u_b_r_o_u_t_i_n_e_s sections any longer. You would need to duplicate the default entries, as well as adding your new one. no default sections 1(1) User Commands 2Programmer Subroutines 3Programmer Subroutines 4(4) Devices 5(5) File Formats 6(6) Games Page 3 (printed 4/30/98) XXXXMMMMAAAANNNN((((1111)))) XXXX VVVVeeeerrrrssssiiiioooonnnn 11111111 ((((RRRReeeelllleeeeaaaasssseeee 5555)))) XXXXMMMMAAAANNNN((((1111)))) 7(7) Miscellaneous 8(8) Sys. Administration l(l) Local n(n) New o(o) Old Xman will read any section that is of the from _m_a_n<_c_h_a_r_a_c_t_e_r>, where <character> is an upper or lower case letter (they are treated distinctly) or a numeral (0-9). Be warned, however, that man(1) and catman(8) will not search directories that are non-standard. WWWWIIIIDDDDGGGGEEEETTTTSSSS In order to specify resources, it is useful to know the hierarchy of the widgets which compose _x_m_a_n. In the notation below, indentation indicates hierarchical structure. The widget class name is given first, followed by the widget instance name. Xman xman (_T_h_i_s _w_i_d_g_e_t _i_s _n_e_v_e_r _u_s_e_d) TopLevelShell topbox Form form LabelLocale topLabel CommandLocale helpButton CommandLocale quitButton CommandLocale manpageButton TransientShell search DialogLocaleWidgetClass dialog LabelLocale label Text value CommandLocale manualPage CommandLocale apropos CommandLocale cancel TransientShell pleaseStandBy LabelLocale label TopLevelShell manualBrowser Paned Manpage_Vpane Paned horizPane MenuButtonLocale options MenuButtonLocale sections LabelLocale manualBrowser Viewport directory ListLocale directory ListLocale directory . . (one for each section, . created on the fly) . ScrollByLine manualPage SimpleMenu optionMenu SmeBSBLocale displayDirectory SmeBSBLocale displayManualPage Page 4 (printed 4/30/98) XXXXMMMMAAAANNNN((((1111)))) XXXX VVVVeeeerrrrssssiiiioooonnnn 11111111 ((((RRRReeeelllleeeeaaaasssseeee 5555)))) XXXXMMMMAAAANNNN((((1111)))) SmeBSBLocale help SmeBSBLocale search SmeBSBLocale showBothScreens SmeBSBLocale removeThisManpage SmeBSBLocale openNewManpage SmeBSBLocale showVersion SmeBSBLocale quit SimpleMenu sectionMenu SmeBSBLocale <name of section> . . (one for each section) . TransientShell search DialogLocaleWidgetClass dialog LabelLocale label Text value CommandLocale manualPage CommandLocale apropos CommandLocale cancel TransientShell pleaseStandBy LabelLocale label TransientShell likeToSave DialogLocale dialog LabelLocale label Text value CommandLocale yes CommandLocale no TopLevelShell help Paned Manpage_Vpane Paned horizPane MenuButtonLocale options MenuButtonLocale sections LabelLocale manualBrowser ScrollByLine manualPage SimpleMenu optionMenu SmeBSBLocale displayDirectory SmeBSBLocale displayManualPage SmeBSBLocale help SmeBSBLocale search SmeBSBLocale showBothScreens SmeBSBLocale removeThisManpage SmeBSBLocale openNewManpage SmeBSBLocale showVersion SmeBSBLocale quit AAAAPPPPPPPPLLLLIIIICCCCAAAATTTTIIIIOOOONNNN RRRREEEESSSSOOOOUUUURRRRCCCCEEEESSSS _x_m_a_n has the following application-specific resources which allow customizations unique to _x_m_a_n. mmmmaaaannnnuuuuaaaallllFFFFoooonnnnttttSSSSeeeettttNNNNoooorrrrmmmmaaaallll (Class FFFFoooonnnnttttSSSSeeeetttt) The font set to use for normal text in the Page 5 (printed 4/30/98) XXXXMMMMAAAANNNN((((1111)))) XXXX VVVVeeeerrrrssssiiiioooonnnn 11111111 ((((RRRReeeelllleeeeaaaasssseeee 5555)))) XXXXMMMMAAAANNNN((((1111)))) manual pages. mmmmaaaannnnuuuuaaaallllFFFFoooonnnnttttSSSSeeeettttBBBBoooolllldddd (Class FFFFoooonnnnttttSSSSeeeetttt) The font set to use for bold text in the manual pages. mmmmaaaannnnuuuuaaaallllFFFFoooonnnnttttSSSSeeeettttIIIIttttaaaalllliiiicccc (Class FFFFoooonnnnttttSSSSeeeetttt) The font set to use for italic text in the manual pages. ddddiiiirrrreeeeccccttttoooorrrryyyyFFFFoooonnnnttttSSSSeeeettttNNNNoooorrrrmmmmaaaallll (Class FFFFoooonnnnttttSSSSeeeetttt) The font set to use for the directory text. bbbbooootttthhhhSSSShhhhoooowwwwnnnn (Class BBBBoooooooolllleeeeaaaannnn) Either `true' or `false,' specifies whether or not you want both the directory and the manual page shown at start up. ddddiiiirrrreeeeccccttttoooorrrryyyyHHHHeeeeiiiigggghhhhtttt (Class DDDDiiiirrrreeeeccccttttoooorrrryyyyHHHHeeeeiiiigggghhhhtttt) The height in pixels of the directory, when the directory and the manual page are shown simultaneously. ttttooooppppCCCCuuuurrrrssssoooorrrr (Class CCCCuuuurrrrssssoooorrrr) The cursor to use in the top box. hhhheeeellllppppCCCCuuuurrrrssssoooorrrr (Class CCCCuuuurrrrssssoooorrrr) The cursor to use in the help window. mmmmaaaannnnppppaaaaggggeeeeCCCCuuuurrrrssssoooorrrr (Class CCCCuuuurrrrssssoooorrrr) The cursor to use in the manual page window. sssseeeeaaaarrrrcccchhhhEEEEnnnnttttrrrryyyyCCCCuuuurrrrssssoooorrrr (Class CCCCuuuurrrrssssoooorrrr) The cursor to use in the search entry text widget. ppppooooiiiinnnntttteeeerrrrCCCCoooolllloooorrrr (Class FFFFoooorrrreeeeggggrrrroooouuuunnnndddd) This is the color of all the cursors (pointers) specified above. The name was chosen to be compatible with xterm. hhhheeeellllppppFFFFiiiilllleeee (Class FFFFiiiilllleeee) Use this rather than the system default helpfile. ttttooooppppBBBBooooxxxx (Class BBBBoooooooolllleeeeaaaannnn) Either `true' or `false,' determines whether the top box (containing the help, quit and manual page buttons) or a manual page is put on the screen at start-up. Page 6 (printed 4/30/98) XXXXMMMMAAAANNNN((((1111)))) XXXX VVVVeeeerrrrssssiiiioooonnnn 11111111 ((((RRRReeeelllleeeeaaaasssseeee 5555)))) XXXXMMMMAAAANNNN((((1111)))) The default is true. vvvveeeerrrrttttiiiiccccaaaallllLLLLiiiisssstttt (Class BBBBoooooooolllleeeeaaaannnn) Either `true' or `false,' determines whether the directory listing is vertically or horizontally organized. The default is horizontal (false). ccccoooommmmmmmmaaaannnnddddTTTTbbbbllll (Class CCCCoooommmmmmmmaaaannnnddddTTTTbbbbllll) Specify the command of tbl function. The default is tbl. ccccoooommmmmmmmaaaannnnddddEEEEqqqqnnnn (Class CCCCoooommmmmmmmaaaannnnddddEEEEqqqqnnnn) Specify the command of tbl function. The default is neqn ccccoooommmmmmmmaaaannnnddddRRRRooooffffffff (Class CCCCoooommmmmmmmaaaannnnddddRRRRooooffffffff) Specify the command of roff function. The default is nroff. GGGGLLLLOOOOBBBBAAAALLLL AAAACCCCTTTTIIIIOOOONNNNSSSS _X_m_a_n defines all user interaction through global actions. This allows the user to modify the translation table of any widget, and bind any event to the new user action. The list of actions supported by _x_m_a_n are: GGGGoooottttooooPPPPaaaaggggeeee((((_p_a_g_e)))) When used in a manual page display window this will allow the user to move between a directory and manual page display. The _p_a_g_e argument can be either DDDDiiiirrrreeeeccccttttoooorrrryyyy or MMMMaaaannnnuuuuaaaallllPPPPaaaaggggeeee. QQQQuuuuiiiitttt(((()))) This action may be used anywhere, and will exit xman. SSSSeeeeaaaarrrrcccchhhh((((_t_y_p_e,,,, _a_c_t_i_o_n)))) Only useful when used in a search popup, this action will cause the search widget to perform the named search type on the string in the search popup's value widget. This action will also pop down the search widget. The _t_y_p_e argument can be either AAAApppprrrrooooppppoooossss, MMMMaaaannnnppppaaaaggggeeee or CCCCaaaannnncccceeeellll. If an _a_c_t_i_o_n of OOOOppppeeeennnn is specified then xman will open a new manual page to display the results of the search, otherwise xman will attempt to display the results in the parent of the search popup. PPPPooooppppuuuuppppHHHHeeeellllpppp(((()))) This action may be used anywhere, and will popup the help widget. PPPPooooppppuuuuppppSSSSeeeeaaaarrrrcccchhhh(((()))) This action may be used anywhere except in a Page 7 (printed 4/30/98) XXXXMMMMAAAANNNN((((1111)))) XXXX VVVVeeeerrrrssssiiiioooonnnn 11111111 ((((RRRReeeelllleeeeaaaasssseeee 5555)))) XXXXMMMMAAAANNNN((((1111)))) help window. It will cause the search popup to become active and visible on the screen, allowing the user search for a manual page. CCCCrrrreeeeaaaatttteeeeNNNNeeeewwwwMMMMaaaannnnppppaaaaggggeeee(((()))) This action may be used anywhere, and will create a new manual page display window. RRRReeeemmmmoooovvvveeeeTTTThhhhiiiissssMMMMaaaannnnppppaaaaggggeeee(((()))) This action may be used in any manual page or help display window. When called it will remove the window, and clean up all resources associated with it. SSSSaaaavvvveeeeFFFFoooorrrrmmmmaaaatttttttteeeeddddPPPPaaaaggggeeee((((_a_c_t_i_o_n)))) This action can only be used in the lllliiiikkkkeeeeTTTTooooSSSSaaaavvvveeee popup widget, and tells xman whether to SSSSaaaavvvveeee or CCCCaaaannnncccceeeellll a save of the manual page that has just been formatted. SSSShhhhoooowwwwVVVVeeeerrrrssssiiiioooonnnn(((()))) This action may be called from any manual page or help display window, and will cause the informational display line to show the current version of xman. FFFFIIIILLLLEEEESSSS <_m_a_n_p_a_t_h _d_i_r_e_c_t_o_r_y>/man<_c_h_a_r_a_c_t_e_r> <_m_a_n_p_a_t_h _d_i_r_e_c_t_o_r_y>/cat<_c_h_a_r_a_c_t_e_r> <_m_a_n_p_a_t_h _d_i_r_e_c_t_o_r_y>/mandesc /usr/lib/X11/app-defaults/Xman specifies required resources /tmp _X_m_a_n creates temporary files in /tmp for all unformatted man pages and all apropos searches. SSSSEEEEEEEE AAAALLLLSSSSOOOO _X(1), _m_a_n(1), _a_p_r_o_p_o_s(1), _c_a_t_m_a_n(8), _A_t_h_e_n_a _W_i_d_g_e_t _S_e_t EEEENNNNVVVVIIIIRRRROOOONNNNMMMMEEEENNNNTTTT DDDDIIIISSSSPPPPLLLLAAAAYYYY the default host and display to use. MMMMAAAANNNNPPPPAAAATTTTHHHH the search path for manual pages. Directories are separated by colons (e.g. /usr/man:/mit/kit/man:/foo/bar/man). XXXXEEEENNNNVVVVIIIIRRRROOOONNNNMMMMEEEENNNNTTTT to get the name of a resource file that overrides the global resources stored in the RESOURCE_MANAGER property. Page 8 (printed 4/30/98) XXXXMMMMAAAANNNN((((1111)))) XXXX VVVVeeeerrrrssssiiiioooonnnn 11111111 ((((RRRReeeelllleeeeaaaasssseeee 5555)))) XXXXMMMMAAAANNNN((((1111)))) XXXXAAAAPPPPPPPPLLLLRRRREEEESSSSDDDDIIIIRRRR A string that will have ``Xman'' appended to it. This string will be the full path name of a user app-defaults file to be merged into the resource database after the system app- defaults file, and before the resources that are attached to the display. XXXXNNNNLLLLSSSSPPPPAAAATTTTHHHH To access the locale database that overrides the default path /usr/lib/X11/nls. LLLLAAAANNNNGGGG A string that will specify the language in which xman browse manual. BBBBUUUUGGGGSSSS The 3 styles of fonts, normal, bold and italic are used often in English manual, however some eastern languages such Japanese and Chinese have no italic style. So when you browse the manual written in mixed of English and other language, say Japanese, it is strongly recommended that you should choose apporopriate fonts whose sizes are consistent in the English and Kanji characters, for example, choosing Latin-1 font with CharCell spacing for English as can as possible. Otherwise the vertical line on the manual page would not be looks nice, specially in the case of Latin-1 font with proportional spacing(variable pitch). For example the widths of blank " " and the letter "M" are different, they cause some indents are different. CCCCOOOOPPPPYYYYRRRRIIIIGGGGHHHHTTTT Copyright 1992 by OMRON Corporation. Copyright 1988 by Massachusetts Institute of Technology. See _X(_1) for a full statement of rights and permissions. AAAAUUUUTTTTHHHHOOOORRRRSSSS Chris Peterson, MIT X Consortium from the V10 version written by Barry Shein formerly of Boston University. Page 9 (printed 4/30/98)